/*
 * Copyright (C) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.sentry;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * Sentry SDK internal logging interface.
 *
 * @since 2021-06-02
 **/
public interface ILogger {

    /**
     * Logs a message with the specified level, message and optional arguments.
     *
     * @param level The SentryLevel.
     * @param message The message.
     * @param args The optional arguments to format the message.
     */
    void log(@NotNull SentryLevel level, @NotNull String message, @Nullable Object... args);

    /**
     * Logs a message with the specified level, message and optional arguments.
     *
     * @param level The SentryLevel.
     * @param message The message.
     * @param throwable The throwable to log.
     */
    void log(@NotNull SentryLevel level, @NotNull String message, @Nullable Throwable throwable);

    /**
     * Logs a message with the specified level, throwable, message and optional arguments.
     *
     * @param level The SentryLevel.
     * @param throwable The throwable to log.
     * @param message The message.
     * @param args the formatting arguments
     */
    void log(
        @NotNull SentryLevel level,
        @Nullable Throwable throwable,
        @NotNull String message,
        @Nullable Object... args);

    /**
     * Whether this logger is enabled for the specified SentryLevel.
     *
     * @param level The SentryLevel to test against.
     * @return True if a log message would be recorded for the level. Otherwise false.
     */
    boolean isEnabled(@Nullable SentryLevel level);
}
